<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>spi: XSpi Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">spi
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">XSpi Struct Reference<div class="ingroups"><a class="el" href="group__spi__v4__1.html">Spi_v4_1</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The user is required to allocate a variable of this type for every SPI device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a147b71a67279bdf53d36a4ffc8432599"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi::BaseAddr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base address of device (IPIF) </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, <a class="el" href="group__spi__v4__1.html#ga343938fcdf672bec329d876a146178cd">XSpi_Reset()</a>, <a class="el" href="group__spi__v4__1.html#ga11b6ebdb6f69c6939176e05600b10e3e">XSpi_SelfTest()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="aac3d52799cee844afec78ffc203c4b20"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi::DataWidth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Data Transfer Width 8 or 16 or 32. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="afcb2a94604b619e207e5590328c3531e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi::FlashBaseAddr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Used in XIP Mode. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a67a6dd9a95f3bef8199dc0186dfb039a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSpi::HasFifos</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is configured with FIFOs or not. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga44a2dc795761b35ed0ebdd6989675022">XSpi_Abort()</a>, <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, and <a class="el" href="group__spi__v4__1.html#ga11b6ebdb6f69c6939176e05600b10e3e">XSpi_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="a35871d4554b45a9078edfabb763cc1a5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSpi::IsBusy</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A transfer is in progress (state) </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga44a2dc795761b35ed0ebdd6989675022">XSpi_Abort()</a>, <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, <a class="el" href="group__spi__v4__1.html#ga67c2076b133a55b6f80343642a1ace41">XSpi_SetOptions()</a>, <a class="el" href="group__spi__v4__1.html#ga162523a3e9b29f063701db303ac8cf17">XSpi_SetSlaveSelect()</a>, <a class="el" href="group__spi__v4__1.html#gad4bb67cfcfe73844ffb1917b11d5284c">XSpi_Stop()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a19847c6916d3d7a325a2cebab966018a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSpi::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf243ac522e14869af82545ffc11d5821">XSpi_ClearStats()</a>, <a class="el" href="group__spi__v4__1.html#gaf55cfd2072ed2047c0fe0b65bd0fcf6a">XSpi_GetOptions()</a>, <a class="el" href="group__spi__v4__1.html#ga8043891b8f68a3291bd035be74aa6b94">XSpi_GetSlaveSelect()</a>, <a class="el" href="group__spi__v4__1.html#ga8a40aee30eb6f0240b75e6ccd7596a53">XSpi_GetStats()</a>, <a class="el" href="group__spi__v4__1.html#ga343938fcdf672bec329d876a146178cd">XSpi_Reset()</a>, <a class="el" href="group__spi__v4__1.html#ga11b6ebdb6f69c6939176e05600b10e3e">XSpi_SelfTest()</a>, <a class="el" href="group__spi__v4__1.html#ga67c2076b133a55b6f80343642a1ace41">XSpi_SetOptions()</a>, <a class="el" href="group__spi__v4__1.html#ga162523a3e9b29f063701db303ac8cf17">XSpi_SetSlaveSelect()</a>, <a class="el" href="group__spi__v4__1.html#gabc09f4d503de2a772e5079ac46fc62b6">XSpi_SetStatusHandler()</a>, <a class="el" href="group__spi__v4__1.html#ga87fdaad742a2669200c9b2617e5c86ea">XSpi_Start()</a>, <a class="el" href="group__spi__v4__1.html#gad4bb67cfcfe73844ffb1917b11d5284c">XSpi_Stop()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a71a59342f02363d57536aeefd2aa7a3f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSpi::IsStarted</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device has been started. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#ga343938fcdf672bec329d876a146178cd">XSpi_Reset()</a>, <a class="el" href="group__spi__v4__1.html#ga87fdaad742a2669200c9b2617e5c86ea">XSpi_Start()</a>, <a class="el" href="group__spi__v4__1.html#gad4bb67cfcfe73844ffb1917b11d5284c">XSpi_Stop()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="ab2896a95a00faec5cee34d83093ffb3f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi::NumSlaveBits</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of slave selects for this device. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, and <a class="el" href="group__spi__v4__1.html#ga162523a3e9b29f063701db303ac8cf17">XSpi_SetSlaveSelect()</a>.</p>

</div>
</div>
<a class="anchor" id="acc5a98e31ed6927b50d6bff4c87f5bb9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8* XSpi::RecvBufferPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to receive. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a883553e7813c71d61fc1f84de68d9bf4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XSpi::RemainingBytes</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Bytes left to transfer (state) </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga44a2dc795761b35ed0ebdd6989675022">XSpi_Abort()</a>, <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a1f78cff15e7571d1db3630834d376877"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XSpi::RequestedBytes</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Total bytes to transfer (state) </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga44a2dc795761b35ed0ebdd6989675022">XSpi_Abort()</a>, <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="af85c6077464bc0877fe6334564b9430c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8* XSpi::SendBufferPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to send. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a282ea84ad4ceb9e950bb91b66231780b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi::SlaveOnly</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is configured to be slave only. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, and <a class="el" href="group__spi__v4__1.html#ga67c2076b133a55b6f80343642a1ace41">XSpi_SetOptions()</a>.</p>

</div>
</div>
<a class="anchor" id="a0ba738ff1f34e3e5af78c7437df1073f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi::SlaveSelectMask</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mask that matches the number of SS bits. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga44a2dc795761b35ed0ebdd6989675022">XSpi_Abort()</a>, <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, <a class="el" href="group__spi__v4__1.html#ga343938fcdf672bec329d876a146178cd">XSpi_Reset()</a>, <a class="el" href="group__spi__v4__1.html#ga11b6ebdb6f69c6939176e05600b10e3e">XSpi_SelfTest()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a4dda79fe6ae8a3536b0aaaa62be0d8b5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpi::SlaveSelectReg</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Slave select register. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#ga8043891b8f68a3291bd035be74aa6b94">XSpi_GetSlaveSelect()</a>, <a class="el" href="group__spi__v4__1.html#ga343938fcdf672bec329d876a146178cd">XSpi_Reset()</a>, <a class="el" href="group__spi__v4__1.html#ga162523a3e9b29f063701db303ac8cf17">XSpi_SetSlaveSelect()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a9816437229050cd78cb29c4f762228b7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi::SpiMode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Standard/Dual/Quad mode. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, and <a class="el" href="group__spi__v4__1.html#ga11b6ebdb6f69c6939176e05600b10e3e">XSpi_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="a63d1a1254869f2599e4646388cec0c4c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_spi___stats.html">XSpi_Stats</a> XSpi::Stats</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Statistics. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf243ac522e14869af82545ffc11d5821">XSpi_ClearStats()</a>, <a class="el" href="group__spi__v4__1.html#ga8a40aee30eb6f0240b75e6ccd7596a53">XSpi_GetStats()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer()</a>.</p>

</div>
</div>
<a class="anchor" id="a032c4db15af79e91cc2fcf564dea1b55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__spi__v4__1.html#ga07ccc0ae5e77f261e02c22b8275c43c8">XSpi_StatusHandler</a> XSpi::StatusHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Status Handler. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#gabc09f4d503de2a772e5079ac46fc62b6">XSpi_SetStatusHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="aa4075b1e4be099fe87f575b777628a78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XSpi::StatusRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback reference for status handler. </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler()</a>, and <a class="el" href="group__spi__v4__1.html#gabc09f4d503de2a772e5079ac46fc62b6">XSpi_SetStatusHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a36bd7deea43721717288da63415e8fdd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XSpi::XipMode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>0 if Non-XIP, 1 if XIP Mode </p>

<p>Referenced by <a class="el" href="group__spi__v4__1.html#ga48d8cea3864b01b7eed7320e83beacf1">XSpi_CfgInitialize()</a>, and <a class="el" href="group__spi__v4__1.html#ga11b6ebdb6f69c6939176e05600b10e3e">XSpi_SelfTest()</a>.</p>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
